List Templates For Documents
AutomatR.DocuSign.Activities.ListTemplatesForDocuments
The "List Templates For Documents" activity in AutomatR is part of the DocuSign Get templates by Document package, designed to retrieve the templates associated with a specific document within the specified envelope. This activity facilitates efficient management of templates associated with documents in the DocuSign workflow.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID of the document to retrieve associated templates. String variables containing the Envelope ID. |
| Document ID | Enter the Document ID of the document for which templates need to be retrieved. String variables containing the Document ID. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "List Templates For Documents" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Response | Returns all the templates with data type 'TemplateInformation'. Variables of data type List<TemplateSummary> to store the list of templates associated with the specified document. |
How to use:
- Drag and drop the "List Templates For Documents" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and Document ID for which templates need to be retrieved.
- Optionally, configure the delay.
- Execute the workflow to retrieve a list of templates associated with the specified document.
Important Notes:
- Ensure that the "List Templates For Documents" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "List Templates For Documents" activity is used to retrieve templates associated with a specific document in a DocuSign envelope:
List Templates For Documents:
Delay: 5
Envelope ID: "Envelope123"
Document ID: "Document456"
Response: templateList
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves a list of templates associated with the document having the Envelope ID "Envelope123" and Document ID "Document456". The list of templates is stored in the variable "templateList" for further processing in the workflow.